PayPay随時・登録型都度決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranPaypay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
JobCd	jobCd	必須半角英字7桁処理区分 AUTH：仮売上 CAPTURE：即時売上 ※決済タイプに1:随時決済を指定した場合、CAPTUREのみ指定可能です。 ※決済タイプに2:登録型都度決済を指定した場合、AUTHのみ指定可能です。
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料
PaymentType	paymentType	必須半角数字1桁決済タイプ 1：随時決済 2：登録型都度決済

URL

/payment/EntryTranPaypay.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "orderID": "ORDER0000001",
    "jobCd": "CAPTURE",
    "amount": "1000",
    "paymentType": "1"
}

URL

/payment/EntryTranPaypay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=CAPTURE&Amount=1000&PaymentType=1

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranPaypay 決済実行

決済処理を行い結果を返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
PaypayAcceptCode	paypayAcceptCode	必須半角英数14桁 PayPay承諾番号決済に利用するPayPay承諾番号を設定してください。

URL

/payment/ExecTranPaypay.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "paypayAcceptCode": "51111118068276"
}

URL

/payment/ExecTranPaypay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PaypayAcceptCode=51111118068276

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 該当取引のオーダーIDを返却します。
Status	status	必須半角英字7桁現状態 CAPTURE：即時売上
TranDate	tranDate	必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
PaypayTrackingID	paypayTrackingID	必須半角英数14桁 PayPayトラッキングID
CheckString	checkString	必須半角英数64桁改ざんチェック文字列以下の情報を連結し、SHA256ハッシュした値を返却します。・オーダーID ・取引ID ・ショップID ・ショップパスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "20201124-0010",
    "status": "CAPTURE",
    "tranDate": "20201124165711",
    "paypayTrackingID": "79999989971769",
    "checkString": "f03021cf5d3e363d57ff84303b7a39726496c9ae1e1fc893c0da1a2edc392726"
}

レスポンスパラメータ：正常系

OrderID=20201124-0010&Status=CAPTURE&TranDate=20201124165711&PaypayTrackingID=79999989971769&CheckString=f03021cf5d3e363d57ff84303b7a39726496c9ae1e1fc893c0da1a2edc392726

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypaySales 実売上

仮売上の決済に対して実売上を行います。仮売上の決済の取引ID・取引パスワードを指定すると、売上の確定処理が可能です。
※事業者側でエラーになる可能性がありますので、仮売上から数秒空けて実行してください。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、合計利用金額が売上確定となります。仮売上時の合計利用金額に満たない金額を指定した場合、差額はキャンセルされます。（一部実売上の例）　仮売上時の利用金額 = 1000円　指定する利用金額＝ 800円上記の条件で実売上を行った結果　売上金額 = 800円　キャンセル金額 = 200円
Tax	tax	半角数字7桁税送料

URL

/payment/PaypaySales.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "amount": "1000"
}

URL

/payment/PaypaySales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態 SALES：実売上 REQSALES：実売上受付
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "100",
    "tax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=100&Tax=0

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypayCancelReturn キャンセル

取引の取引ID・取引パスワードを指定すると、以前に実施した決済内容をキャンセルすることが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
CancelAmount	cancelAmount	必須半角数字7桁利用金額仮売上、実売上、即時売上時の合計利用金額と一致する金額を設定するとキャンセルします。（一部キャンセルを行いたい場合）キャンセルしたい金額を設定します。設定した金額がお客様に返金され、差額は実売上、即時売上の状態のままとなります。例）　実売上時の利用金額 = 1000円　設定した利用金額＝ 200円上記の条件でキャンセルを行った結果　売上金額 = 800円　キャンセル金額 = 200円
CancelTax	cancelTax	半角数字7桁税送料

URL

/payment/PaypayCancelReturn.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "cancelAmount": "1000"
}

URL

/payment/PaypayCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態　CANCEL：キャンセル　RETURN：返金　SALES：実売上（※）　CAPTURE：即時売上（※） ※一部キャンセルの場合に返却されます。
CancelAmount	cancelAmount	必須半角数字7桁キャンセル利用金額
CancelTax	cancelTax	必須半角数字7桁キャンセル税送料

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "RETURN",
    "cancelAmount": "100",
    "cancelTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=RETURN&CancelAmount=100&CancelTax=0

レスポンスパラメータ：異常系

[
    {
"errCode":"E01",
"errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypayAcceptPush プッシュ課金購入要求

随時決済の決済実行にて残高不足エラー(PP1007010)の場合、プッシュ通知にてお客様へ支払い依頼を送ることができます。
※登録型都度決済の場合、プッシュ課金購入要求はご利用いただけません。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
PaypayAcceptCode	paypayAcceptCode	必須半角英数14桁 PayPay承諾番号
ExpiredDatetime	expiredDatetime	半角数字14桁固定プッシュ課金有効期限お客様が支払いを行う有効期限を設定します。無指定の場合、6時間になります。 yyyyMMddHHmm書式 ※入力可能な範囲は、現在時刻に対して10分以上48時間以内となります。

URL

/payment/PaypayAcceptPush.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "paypayAcceptCode": "51111118068276"
}

URL

/payment/PaypayAcceptPush.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PaypayAcceptCode=51111118068276

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態　REQPUSH：プッシュ課金要求中
TranDate	tranDate	必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
PushTrackingID	pushTrackingID	必須半角英字14桁プッシュ通知トラッキングID

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "REQPUSH",
    "tranDate": "20201201000000",
    "pushTrackingID": "12345678901234"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REQPUSH&TranDate=20201201000000&PushTrackingID=12345678901234

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypayAcceptPushCancel プッシュ課金取消

支払期限内にお客様が同意されていない場合、取消できます。
※登録型都度決済の場合、プッシュ課金購入要求はご利用いただけません。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。

URL

/payment/PaypayAcceptPushCancel.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001"
}

URL

/payment/PaypayAcceptPushCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		orderID		必須半角英数記号27桁オーダーID
Status		status		必須現状態 PUSHCANCEL：プッシュ課金取消

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "PUSHCANCEL"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=PUSHCANCEL

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
PayType		必須半角数字2桁決済方法 45：PayPay

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=45

レスポンス

正常

Status		必須現状態 UNPROCESSED：未決済 AUTH：仮売上 CAPTURE：即時売上 SALES：実売上 CANCEL：キャンセル RETURN：返金 REQPUSH：プッシュ課金要求中 PUSHCANCEL：プッシュ課金取消 PUSHEXPIRED：プッシュ課金期限切れ
ProcessDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		必須処理区分 AUTH：仮売上 CAPTURE：即時売上 SALES：実売上 CANCEL：キャンセル RETURN：返金 REQPUSH：プッシュ課金要求 PUSHCANCEL：プッシュ課金取消 PUSUEXPIRE：プッシュ課金期限切れ
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
Amount		必須半角数字7桁利用金額
Tax		必須半角数字7桁税送料
ClientField1		必須全半角100バイト加盟店自由項目1
ClientField2		必須全半角100バイト加盟店自由項目2
ClientField3		必須全半角100バイト加盟店自由項目3
PayType		必須半角数字2桁決済方法 45：PayPay
PayPayCancelAmount		必須半角数字7桁キャンセル金額該当取引について発生したキャンセル・返金額を返却します。
PayPayCancelTax		必須半角数字7桁キャンセル税送料金額該当取引について発生したキャンセル・返金税送料を返却します。
PayPayTrackingID		半角英数14桁 PayPayトラッキングID
PayPayAcceptCode		半角英数14桁 PayPay承諾番号
PayPayOrderID		半角英数20桁 PayPay決済番号

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=CAPTURE&ProcessDate=20191216090000&JobCd=CAPTURE&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&Amount=10000&Tax=1000&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=45&PayPayCancelAmount=500&PayPayCancelTax=50&PayPayTrackingID=12345678901234&PayPayAcceptCode=51111118068276&PayPayOrderID=03694684018076303999

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PayPay